Skip to main content
`Ctrl`+`K`

# ng911ok.tools.msag.msagng911comparison module

authors:

  Riley Baird (OK), Emma Baker (OK)

class CustomToolParameterInfo

  Bases: `object`

class MSAGNG911Comparison

  Bases: `object`

  execute(parameters, messages)

    The source code of the tool.

  getParameterInfo()

    Define parameter definitions

  isLicensed()

    Set whether tool is licensed to execute.

  updateMessages(parameters)

    Modify the messages created by internal validation for each tool parameter. This method is called after internal validation.

  updateParameters(parameters)

    Modify the values and properties of parameters before internal validation is performed. This method is called whenever a parameter has been changed.

custom_param

  alias of `CustomToolParameterInfo`

comparison_msag_ng911(msag_df: DataFrame, ng911_df: DataFrame, msag_user_dict: dict[str, str], fc_name: str) → DataFrame | str

  TEXT :param msag_df: :param ng911_df: :param msag_user_dict: :param fc_name: :return:

comparison_tn_ng911(tn_df: DataFrame, ng911_df: DataFrame, tn_file_dict: dict[str, str], fc_name: str) → DataFrame | str

  TEXT :param tn_df: :param ng911_df: :param tn_file_dict: :param fc_name: :return:

field_analysis_for_df(analysis_df: DataFrame, user_field_list: list[str], std_field_list: list[str], current_field_key: str, analysis_field: str | list[str], ng911_suffix: str) → DataFrame

  Checks if analysis field(s) for a given object in the joined and processed analysis_df is a possible match between the MSAG/TN object and corresponding NG911 object(s). Returns “YES” if the values match and “NO” if the values do not match. :param analysis_df: A joined and processed dataframe between the MSAG/TN information and the appropriate NG911 feature class. :param user_field_list: Either a list of user-specified fields that are used to access viable possible matches. :param std_field_list: Either a list of NG911 fields that are used to access viable possible matches. :param current_field_key: Current analysis key (used for printing message). :param analysis_field: Dataframe field name(s) for return object information. :param ng911_suffix: Join field suffix str (when needed). :return: A Dataframe with analysis results.

get_file_df(path: str) → DataFrame | None